Node / meshtastic / Meshtastic-Android / files / feature / docs / src / commonMain / kotlin / org / meshtastic / feature / docs / data / KeywordSearchEngine.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.feature.docs.data

Tff7b72import T7ee787org.koin.core.annotation.Single

Tff7b72import T7ee787org.meshtastic.feature.docs.model.DocPage

Tff7b72import T7ee787org.meshtastic.feature.docs.model.DocSearchQuery

Tff7b72import T7ee787org.meshtastic.feature.docs.model.DocSearchResult

T8b949e/**

* Keyword-based search engine for the docs corpus. Provides search functionality without AI, working on all platforms.

*/

Tf0883e@Single

Tff7b72class T56d364KeywordSearchEngineTb4b4b4(Tff7b72private Tff7b72val Te6edf3bundleLoaderTb4b4b4: Te6edf3DocBundleLoaderTb4b4b4) Tb4b4b4{

Tff7b72private Tff7b72val Te6edf3stopWords Tff7b72=

Te6edf3setOfTb4b4b4(

Ta5d6ff"Ta5d6fftheTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffaTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffanTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffisTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffareTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffwasTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffwereTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffbeTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffbeenTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6fftoTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffofTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffinTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffforTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffonTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffwithTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffatTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffbyTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6fffromTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffitTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffthisTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffthatTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffhowTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffwhatTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffwhereTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffwhenTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffdoTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffdoesTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffcanTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffwillTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffmyTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffiTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffmeTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6ffandTa5d6ff"Tb4b4b4,

Ta5d6ff"Ta5d6fforTa5d6ff"Tb4b4b4,

Tb4b4b4)

T8b949e/** Search the docs corpus with the given query text. */

Tf0883e@SuppressTb4b4b4(Ta5d6ff"Ta5d6ffReturnCountTa5d6ff"Tb4b4b4)

Tff7b72suspend Tff7b72fun Td2a8ffsearchTb4b4b4(Te6edf3queryTextTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Te6edf3ListTff7b72<Te6edf3DocSearchResultTff7b72> Tb4b4b4{

Tff7b72if Tb4b4b4(Te6edf3queryTextTb4b4b4.Te6edf3isBlankTb4b4b4(Tb4b4b4)Tb4b4b4) Tff7b72return Te6edf3emptyListTb4b4b4(Tb4b4b4)

Tff7b72val Te6edf3query Tff7b72= Te6edf3normalizeTb4b4b4(Te6edf3queryTextTb4b4b4)

Tff7b72if Tb4b4b4(Te6edf3queryTb4b4b4.Te6edf3normalizedTermsTb4b4b4.Te6edf3isEmptyTb4b4b4(Tb4b4b4)Tb4b4b4) Tff7b72return Te6edf3emptyListTb4b4b4(Tb4b4b4)

Tff7b72val Te6edf3bundle Tff7b72= Te6edf3bundleLoaderTb4b4b4.Te6edf3loadTb4b4b4(Tb4b4b4)

Tff7b72return Te6edf3bundleTb4b4b4.Te6edf3pages

Tb4b4b4.Te6edf3map Tb4b4b4{ Te6edf3page Tff7b72-Tff7b72> Te6edf3scoreTb4b4b4(Te6edf3pageTb4b4b4, Te6edf3queryTb4b4b4) Tb4b4b4}

Tb4b4b4.Te6edf3filter Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3score Tff7b72> T79c0ff0 Tb4b4b4}

Tb4b4b4.Te6edf3sortedWithTb4b4b4(Te6edf3compareByDescendingTff7b72<Te6edf3DocSearchResultTff7b72> Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3score Tb4b4b4}Tb4b4b4.Te6edf3thenBy Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3pageTb4b4b4.Te6edf3navOrder Tb4b4b4}Tb4b4b4)

Tb4b4b4}

T8b949e/** Select top pages within a token budget for AI retrieval context. */

Tff7b72suspend Tff7b72fun Td2a8ffselectForTokenBudgetTb4b4b4(Te6edf3queryTextTb4b4b4: Tffa657StringTb4b4b4, Te6edf3maxCharsTb4b4b4: Tffa657IntTb4b4b4)Tb4b4b4: Te6edf3ListTff7b72<Te6edf3DocPageTff7b72> Tb4b4b4{

Tff7b72val Te6edf3results Tff7b72= Te6edf3searchTb4b4b4(Te6edf3queryTextTb4b4b4)

Tff7b72val Te6edf3selected Tff7b72= Te6edf3mutableListOfTff7b72<Te6edf3DocPageTff7b72>Tb4b4b4(Tb4b4b4)

Tff7b72var Te6edf3totalChars Tff7b72= T79c0ff0

Tff7b72for Tb4b4b4(Te6edf3result Tff7b72in Te6edf3resultsTb4b4b4) Tb4b4b4{

Tff7b72if Tb4b4b4(Te6edf3totalChars Tff7b72+ Te6edf3resultTb4b4b4.Te6edf3pageTb4b4b4.Te6edf3charCount Tff7b72> Te6edf3maxCharsTb4b4b4) Tff7b72break

Te6edf3selectedTb4b4b4.Te6edf3addTb4b4b4(Te6edf3resultTb4b4b4.Te6edf3pageTb4b4b4)

Te6edf3totalChars Tff7b72+Tff7b72= Te6edf3resultTb4b4b4.Te6edf3pageTb4b4b4.Te6edf3charCount

Tb4b4b4}

Tff7b72return Te6edf3selected

Tb4b4b4}

Tff7b72fun Td2a8ffnormalizeTb4b4b4(Te6edf3queryTextTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Te6edf3DocSearchQuery Tb4b4b4{

Tff7b72val Te6edf3terms Tff7b72=

Te6edf3queryText

Tb4b4b4.Te6edf3lowercaseTb4b4b4(Tb4b4b4)

Tb4b4b4.Te6edf3replaceTb4b4b4(Te6edf3RegexTb4b4b4(Ta5d6ff"Ta5d6ff[^Ta5d6ff\\Ta5d6ffp{L}Ta5d6ff\\Ta5d6ffp{N}Ta5d6ff\\Ta5d6ffs-]Ta5d6ff"Tb4b4b4)Tb4b4b4, Ta5d6ff"Ta5d6ff Ta5d6ff"Tb4b4b4)

Tb4b4b4.Te6edf3splitTb4b4b4(Te6edf3RegexTb4b4b4(Ta5d6ff"Ta5d6ff\\Ta5d6ffs+Ta5d6ff"Tb4b4b4)Tb4b4b4)

Tb4b4b4.Te6edf3filter Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3length Tff7b72>Tff7b72= T79c0ff2 Tff7b72&Tff7b72& Tffa657it Tff7b72!in Te6edf3stopWords Tb4b4b4}

Tb4b4b4.Te6edf3distinctTb4b4b4(Tb4b4b4)

Tff7b72return Te6edf3DocSearchQueryTb4b4b4(Te6edf3rawText Tff7b72= Te6edf3queryTextTb4b4b4, Te6edf3normalizedTerms Tff7b72= Te6edf3termsTb4b4b4)

Tb4b4b4}

Tf0883e@SuppressTb4b4b4(Ta5d6ff"Ta5d6ffLoopWithTooManyJumpStatementsTa5d6ff"Tb4b4b4)

Tff7b72private Tff7b72fun Td2a8ffscoreTb4b4b4(Te6edf3pageTb4b4b4: Te6edf3DocPageTb4b4b4, Te6edf3queryTb4b4b4: Te6edf3DocSearchQueryTb4b4b4)Tb4b4b4: Te6edf3DocSearchResult Tb4b4b4{

Tff7b72var Te6edf3totalScore Tff7b72= T79c0ff0

Tff7b72val Te6edf3matchedTerms Tff7b72= Te6edf3mutableListOfTff7b72<Tffa657StringTff7b72>Tb4b4b4(Tb4b4b4)

Tff7b72for Tb4b4b4(Te6edf3term Tff7b72in Te6edf3queryTb4b4b4.Te6edf3normalizedTermsTb4b4b4) Tb4b4b4{

T8b949e// Title match (highest priority)

Tff7b72if Tb4b4b4(Te6edf3pageTb4b4b4.Te6edf3titleTb4b4b4.Te6edf3lowercaseTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3containsTb4b4b4(Te6edf3termTb4b4b4)Tb4b4b4) Tb4b4b4{

Te6edf3totalScore Tff7b72+Tff7b72= Te6edf3TITLE_MATCH_SCORE

Te6edf3matchedTermsTb4b4b4.Te6edf3addTb4b4b4(Te6edf3termTb4b4b4)

Tff7b72continue

Tb4b4b4}

T8b949e// Exact keyword match

Tff7b72if Tb4b4b4(Te6edf3pageTb4b4b4.Te6edf3keywordsTb4b4b4.Te6edf3any Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3lowercaseTb4b4b4(Tb4b4b4) Tff7b72=Tff7b72= Te6edf3term Tb4b4b4}Tb4b4b4) Tb4b4b4{

Te6edf3totalScore Tff7b72+Tff7b72= Te6edf3KEYWORD_EXACT_SCORE

Te6edf3matchedTermsTb4b4b4.Te6edf3addTb4b4b4(Te6edf3termTb4b4b4)

Tff7b72continue

Tb4b4b4}

T8b949e// Partial keyword match

Tff7b72if Tb4b4b4(Te6edf3pageTb4b4b4.Te6edf3keywordsTb4b4b4.Te6edf3any Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3lowercaseTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3containsTb4b4b4(Te6edf3termTb4b4b4) Tb4b4b4}Tb4b4b4) Tb4b4b4{

Te6edf3totalScore Tff7b72+Tff7b72= Te6edf3KEYWORD_PARTIAL_SCORE

Te6edf3matchedTermsTb4b4b4.Te6edf3addTb4b4b4(Te6edf3termTb4b4b4)

Tff7b72continue

Tb4b4b4}

T8b949e// Alias match

Tff7b72if Tb4b4b4(Te6edf3pageTb4b4b4.Te6edf3aliasesTb4b4b4.Te6edf3any Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3lowercaseTb4b4b4(Tb4b4b4) Tff7b72=Tff7b72= Te6edf3term Tff7b72|Tff7b72| Tffa657itTb4b4b4.Te6edf3lowercaseTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3containsTb4b4b4(Te6edf3termTb4b4b4) Tb4b4b4}Tb4b4b4) Tb4b4b4{

Te6edf3totalScore Tff7b72+Tff7b72= Te6edf3ALIAS_MATCH_SCORE

Te6edf3matchedTermsTb4b4b4.Te6edf3addTb4b4b4(Te6edf3termTb4b4b4)

Tff7b72continue

Tb4b4b4}

T8b949e// ID/slug match

Tff7b72if Tb4b4b4(Te6edf3pageTb4b4b4.Te6edf3idTb4b4b4.Te6edf3containsTb4b4b4(Te6edf3termTb4b4b4)Tb4b4b4) Tb4b4b4{

Te6edf3totalScore Tff7b72+Tff7b72= Te6edf3ID_MATCH_SCORE

Te6edf3matchedTermsTb4b4b4.Te6edf3addTb4b4b4(Te6edf3termTb4b4b4)

Tb4b4b4}

Tb4b4b4}

Tff7b72return Te6edf3DocSearchResultTb4b4b4(Te6edf3page Tff7b72= Te6edf3pageTb4b4b4, Te6edf3score Tff7b72= Te6edf3totalScoreTb4b4b4, Te6edf3matchedTerms Tff7b72= Te6edf3matchedTermsTb4b4b4)

Tb4b4b4}

Tff7b72companion Tff7b72object Tb4b4b4{

Tff7b72const Tff7b72val Te6edf3TITLE_MATCH_SCORE Tff7b72= T79c0ff1T79c0ff0

Tff7b72const Tff7b72val Te6edf3KEYWORD_EXACT_SCORE Tff7b72= T79c0ff7

Tff7b72const Tff7b72val Te6edf3KEYWORD_PARTIAL_SCORE Tff7b72= T79c0ff4

Tff7b72const Tff7b72val Te6edf3ALIAS_MATCH_SCORE Tff7b72= T79c0ff5

Tff7b72const Tff7b72val Te6edf3ID_MATCH_SCORE Tff7b72= T79c0ff3

Tb4b4b4}

Tb4b4b4}